Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
OspfMainProcess Class Reference

OspfMainProcess is the main process that handles all OSPF processes. More...

Inheritance diagram for OspfMainProcess:
Process

Public Member Functions

bool addOspfProcess (int)
 Adds an OSPF process with the specified ID. More...
 
bool removeOspfProcess (int)
 Removes the OSPF process with the specified ID. More...
 
Process getOspfProcessAt (int)
 Returns the OSPF process at the specified index. More...
 
Process getOspfProcess (int)
 Returns the OSPF process with the specified ID. More...
 
int getOspfProcessCount ()
 Returns the number of OSPF processes. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

OspfMainProcess is the main process that handles all OSPF processes.

Member Function Documentation

◆ addOspfProcess()

bool OspfMainProcess::addOspfProcess ( int  )

Adds an OSPF process with the specified ID.

Parameters
id,theID for the OSPF process.
Returns
bool, true if successful, otherwise false.

◆ getOspfProcess()

Process OspfMainProcess::getOspfProcess ( int  )

Returns the OSPF process with the specified ID.

Parameters
id,theID of the OSPF process of interest.
Returns
Process, the Process object with the specified ID.

◆ getOspfProcessAt()

Process OspfMainProcess::getOspfProcessAt ( int  )

Returns the OSPF process at the specified index.

Parameters
index,theindex of the OSPF process of interest.
Returns
Process, the Process object at the specified index.

◆ getOspfProcessCount()

int OspfMainProcess::getOspfProcessCount ( )

Returns the number of OSPF processes.

Returns
int, the number of OSPF processes.

◆ removeOspfProcess()

bool OspfMainProcess::removeOspfProcess ( int  )

Removes the OSPF process with the specified ID.

Parameters
id,theID of the OSPF process.
Returns
bool, true if successful, otherwise false.

The documentation for this class was generated from the following file: